Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version 1 release #132

Merged
merged 11 commits into from
Jan 8, 2024
Merged

Version 1 release #132

merged 11 commits into from
Jan 8, 2024

Conversation

willGraham01
Copy link
Contributor

@willGraham01 willGraham01 commented Jan 4, 2024

See #33 |

  • Publishes the final blog for the version 1 release.
  • Finalises the version 1 changelog.
  • Updates the documentation page to recommend pip install brainglobe if you want to install the tools.
  • Highlights that workflows is also now available.
  • Flags that whilst tools can be manually installed, it's best to get them from the meta-package.

docs/source/blog/version1/version_1_released.md Outdated Show resolved Hide resolved
docs/source/blog/version1/version_1_released.md Outdated Show resolved Hide resolved
docs/source/blog/version1/version_1_released.md Outdated Show resolved Hide resolved
docs/source/community/releases/v1/index.md Outdated Show resolved Hide resolved
docs/source/community/releases/v1/index.md Outdated Show resolved Hide resolved
docs/source/community/releases/v1/index.md Outdated Show resolved Hide resolved
docs/source/documentation/index.md Outdated Show resolved Hide resolved
docs/source/documentation/index.md Outdated Show resolved Hide resolved
docs/source/documentation/index.md Outdated Show resolved Hide resolved
@willGraham01
Copy link
Contributor Author

Re-requesting review in light of the Zulip discussion.

Meta-package docs are under community/developers/repositories/brainglobe-meta. I also moved the orphaned docs from the package repository here too.

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small request, but this is excellent, thanks @willGraham01. This is the type of project structure and documentation that we should have had all along! 🥳

Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, Will - thank you!
A few minor nitpicky comments :)

docs/source/community/releases/v1/index.md Outdated Show resolved Hide resolved
Comment on lines +71 to +74
- `pip install brainglobe` is now the recommended way to install all BrainGlobe tools.
- This will fetch the `brainglobe` meta-package, which includes the latest stable versions of all BrainGlobe tools and napari plugins.
- All tools will be accessible in the install environment as if they had been pip-installed directly.
- If you are updating to `brainglobe` version 1 having previously installed BrainGlobe tools individually, we [recommend you create](#updating-to-version-1) a clean Python environment and install `brainglobe` into this fresh environment to avoid potential package conflicts.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are at least parts of this a duplicate of what we already say on line 50 and should therefore be integrated there or here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parts of it definitely are, but I felt duplicating these parts made more sense than only including them in one place or another. Otherwise it's not really a full changelog, and it's not worth a "see this section" when users only need to be redirected to one sentence?

docs/source/documentation/index.md Outdated Show resolved Hide resolved
Co-authored-by: Alessandro Felder <[email protected]>
@willGraham01 willGraham01 merged commit 073a170 into main Jan 8, 2024
2 checks passed
@willGraham01 willGraham01 deleted the version-1-release branch January 8, 2024 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants